SJBHM Appendix J - Current State of SJRIP RiverWare Model

Type	Count
AggDiversionSite	3
CompObj	1
Confluence	9
DataObj	51
DiversionObject	9
GroundWaterStorage	3
ObjCluster	3
Reach	105
StorageReservoir	3
WaterUser	62
Total	249

SanJuanAtArchuleta
DIV_NMCITZ
DIV_NMHAMM
DIV_NMBLOOM
Animas Below Lightner
SM Returns to 301094
DIV_301094
BFL_301023
DIV_301023
SM Animas Ditch
Florida at Mouth
AnimasFlorida
DIV_30ADS010
SM Aggregate Diversion
AnimasNearCedarHill
DIV_304665
TwinRocks
DIV_304664
Ralston
DIV_NMANIM
DIV_NMFARMMI
DIV_NMGLADE
DIV_NMECHO
DIV_NMFMD
SanJuanAnimas
SanJuanAtFarmington
DIV_NMFRUCAM
LaPlataAtFarmington
SanJuanLaPlata
RET_NMSJGS
DIV_NMSJGS
SJGeneratingStation
DIV_NMJEWV
JewettValley
DIV_NM4CPP
DIV_NMHOGB
DIV_NMCUDEI
CudeiCanal
SanJuanMancos
McElmo Creek Mouth
SanJuanMcElmo
DIV_UTIRR
UtahIrr
ArchuletaDitch
DIV_NMARCH
DIV_NMTURLEY
TurleyDitch
BloomfieldMI
CitizenDitch
Hammond
SanJuanAtFourCorners
SanJuanAtBluff
FourCornersPP
SanJuanAtShiprock
DIV_NMU7NIR
DEP_NMU7NonIr
FruitlandAndCambridge
DIV_NMSRMI
ShiprockMI
FarmingtonGlade
AnimasAtFarmington
RET_NMFMD
EchoDitch
NMAnimasIrr
FarmersMutual
FarmingtonMI
Hogback
DIV_NMU3NIR
DEP_NMU3NonIr
DIV_NMAZTECMI
DIV_NMU2NIR
AztecMI
DEP_NMU2NonIr
DIV_NMU6NIR
DEP_NMU6NonIr
ALPNMSupplyFromAnimas
ALPNMSupplyFromAnimas:ALPShiprock
ALPNMSupplyFromAnimas:ALPAztec
ALPNMSupplyFromAnimas:ALPFarmington
ALPNMSupplyFromAnimas:ALPKirkland
ALPNMSupplyFromAnimas:ALPBloomfield
DIV_ALPNMAnimas
DIV_Unspecified3
DEP_Unspecified3
DIV_ALPToBloomfield
DIV_Unspecified1
DEP_Unspecified1
PumpToRBR
DemandsOnRBR
DemandsOnRBR:RidgesBasinResort
DemandsOnRBR:DgoRuralMI
DemandsOnRBR:LaPlataRuralMI
DemandsOnRBR:AnimasFloridaMI
DemandsOnRBR:Coal
DemandsOnRBR:MancosResort
DemandsOnRBR:UteDurango
DemandsOnRBR:ColoradoBalance
DemandsOnRBR:GasPowerPlant
DemandsOnRBR:DurangoMI
DurangoMIReturns
AnimasAtDurangoPumpingPlant
ALPDurango
ISF_Bluff
BYP_Bluff
ISF_FourCorners
BYP_FourCorners
ISF_Shiprock
BYP_Shiprock
ISF_Farmington
BYP_Farmington
ISF_Archuleta
BYP_Archuleta
NIIP
NIIP:DEP_NIIPUnit3
NIIP:DEP_NIIPUnit5
NIIP:DEP_NIIPUnit6
NIIP:NavajoGallupNIIP
NIIPSubUnit3GW
NIIPSubUnit5GW
NIIPSubUnit6GW
DEP_Unspecified2
DIV_Unspecified2
ALPData
RidgesBasin
Navajo
SM East Mesa Ditch
DIV_Unspecified4
DEP_Unspecified4
DIV_NMNGBAL
NavajoGallupBalance
NavajoData
WaterUserData
SupplementalWater
InitialConditions
SanJuanChamaDiversions
SanJuanChamaRules
SJCMonthlyModelAdjustment
EXP_OsoDiversion
BlancoTunnel
OsoTunnel
AzoteaTunnel
Blanco River
Navajo River
Little Navajo River
EXP_BlancoDiversion
EXP_LittleOsoDiversion
La Plata At Stateline
DIV_NMLPNIR
DIV_NMLPIRR
BFL_NMLPIRR
Pioneer
Enterprise
LaPlataNonIr
LowerLaPlataIrr
SanJuanPiedra
NMPineRiverAreaIrr
USNavajoNonIr
JicarillaNonIr
DIV_NMUSNIR
DIV_NMUSIRR
DIV_NMJICNIR
JicarillaIrr
DIV_NMJICIRR
San Juan Near Carracas
Los Pinos
Spring Creek
Piedra
LosPinosSpring
SanJuanLosPinos
Above Navajo Local Inflows
Heron
ETACMonthlyCIR
ETACDailyCIR by Init Rule
ETACDailyCIR Disagg Step 1
ETACDailyCIR Disagg Step 2
ETACDailyCIR Monthly Avgs
ETACMonthlyCIR Interim Monthly Avg
ETACDailyCIR Disagg HOLD ITERATIONS
Run Setup Data
NewFlowRecs
RBROutflow
NewDailyOutput
SJC Adjustment
BaseflowTargetStats
OldFlowRecs
SJC Shortage Adjustment
San Juan Chama Shortage Net Inflow
Shortage Data
SanJuanRockGulch
Rock Gulch
SM Returns above Navajo
StateMod Return Flows above Navajo
Mancos River Mouth
StateMod Return Flows above Four Corners
StateMod Return Flows above Bluff
SM Returns above Bluff
SM Returns above FC
StateMod Return Flows to 3001094
StateMod Return Flows to 3001023
StateMod Return Flows to 30_ADS010
SM Animas SUIT Reserved
DIV_30_SUIT
StateMod Return Flows to 30_ARS005
SM ARS005 Returns
MODEL CHECKS
San Juan Above Navajo Local Inflows
LocalInflows
San Juan at Farmington Local Inflows
San Juan At Shiprock Local Inflows
San Juan at Four Corners Local Inflows
San Juan at Bluff Local Inflows
La Plata Local Inflows
Animas At Farmington Local Inflows
Animas Near Cedar Hill Local Inflows
Animas Above Florida Local Inflows
DailyFilledHistoricStreamflows
StateModMonthlyBaselineInputs
Daily Disaggregation Fractions
DailyFilledHistoricStreamflowsRA
NIIP and Navajo Gallup Data
Non Irrigation Demands
Annual Depletion Volumes
Annual Depletion Request Volumes
Annual Diversion Request Volumes
Annual Diversion Volumes
Depletion Reporting Config
Average Annual Depletion Request Volume
Average Annual Diversion Request Volume
Average Annual Depletion Volume
Average Annual Diversion Volume
StateModMonthlyBaselineInputs_NoResv
ETAC Setup
TEMP Shortage Analysis
Release Breakdown
Climate Change CIR Adjustment Factors
Climate Change Run Config
StateModMonthlyBaselineInputs_ClimateChange
StateModMonthlyBaselineInputs_SavePreClimateChangeBaselineJustInCase
ETACMonthlyCIR_Baseline
StateModMonthlyBaselineInputs_WithStateModAnalogYearsOnly
StateModMonthlyBaselineInputs_WithStateModAnalogFullCCProcess
Daily Disaggregation Fractions_SHIFTED
DailyFilledHistoricStreamflowsRA_SHIFTED
AdjustedStateModShiftDays
DailyFilledHistoricStreamflows_SHIFTED

This ruleset is used to run the SJRIP RiverWare model.

4.1 End Of Run Rules

4.1.1 Mark Run Finished Completely

Statements

Execution Constraint

Referenced Functions

NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.1.2 Check NIIP GW Calibration

Statements

Execution Constraint

Referenced Functions

Abs
GetRunCycleIndex
HasRuleFiredSuccessfully

4.1.3 Calculate Average Annual Diversions and Depletions

Statements

Execution Constraint

Referenced Functions

ListSubbasin
PreviousDate
GetDates
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully
Split

4.1.4 RC4 - Sum Annual Diversions and Depletions

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolumeSkipNaN
SumSlotSkipNaN
ListSubbasin
PreviousDate
GetDates
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully
Split

4.1.5 RC3 - Sum Annual Diversion and Depletion Requests

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolumeSkipNaN
ListSubbasin
PreviousDate
GetDates
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully
Split

4.1.6 Verify Supplemental Water was Removed

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolumeSkipNaN
Abs
GetRunCycleIndex
HasRuleFiredSuccessfully

4.2 End of Timestep Rules

4.2.1 Save Final Daily Flood Control Reach Flows by Run Cycle

Statements

Execution Constraint

Referenced Functions

IntegerToString
GetRunCycleIndex
GetObject
ColumnLabels
HasRuleFiredSuccessfully

4.2.2 Save Final Daily Mainstem Diversion and Return Flow by Run Cycle

Statements

Execution Constraint

Referenced Functions

ListSubbasin
ListDownstreamObjects
GetRunCycleIndex
FilterByObjType
HasRuleFiredSuccessfully

4.3 Navajo Ops - Cycle 4

4.3.1 NOT YET FINISHED OR IMPLEMENTED -------- RC4 - Coming out of Shortage Years Only - Apply Supplemental Water Correction

Statements

Execution Constraint

4.3.2 REMEMBER THE CHANGES FOR CLIMATE CHANGE RUNS ---------- Set Navajo Cycle 4 Release and Remove Supplemental Water

Statements

Execution Constraint

Referenced Functions

MaxItem
Abs
Min
MinItem
GetMaxReleaseGivenInflow
GetRunCycleIndex
TableInterpolation
HasRuleFiredSuccessfully

4.3.3 Cycle 4 Calculate Downstream Flood Control Limited Navajo Release

Statements

Execution Constraint

Referenced Functions

MaxItem
Min
Max
GetMaxReleaseGivenInflow
HypSim
HypTargetSimWithStatus
GetRunCycleIndex
GetObject
ColumnLabels
TableInterpolation
HasRuleFiredSuccessfully

4.3.4 Cycle 4 Calculate Navajo Flood Control Release

Computes Navajo release to meet demands with baseflow bypasses set.

Statements

Execution Constraint

Referenced Functions

MaxItem
Min
Max
GetMinSpillGivenInflowRelease
GetMaxReleaseGivenInflow
SolveStorage
SolveOutflow
GetRunCycleIndex
TableInterpolation
HasRuleFiredSuccessfully

4.3.5 Cycle 4 Calculate Navajo Release Demand With Baseflow Requirements

Computes Navajo release to meet demands with baseflow bypasses set.

Statements

Execution Constraint

Referenced Functions

NetSubBasinDiversionRequirement
ListDownstreamObjects
GetRunCycleIndex
HasRuleFiredSuccessfully

4.3.6 Cycle 4 Calculate Downstream Baseflow Requirements - Three Gage Average - With Reduced Target Baseflows

Sets engineering slot values from data object slot values.

Statements

Execution Constraint

Referenced Functions

ThreeGageBypassesNEW
Abs
GetRunCycleIndex
HasRuleFiredSuccessfully

4.4 Shortage Sharing Rules - Cycle 4

4.4.1 NO LONGER DONE LIKE THIS - RC4 - March 1 of Shortage Years Only - Reduce Baseflows for Shortage

Statements

Execution Constraint

4.4.2 RC4 - March 1 of Shortage Years Only - Reduce Irrigator Demands for Shortage - Proportional Reduction of Depletion Request

Statements

Execution Constraint

Referenced Functions

ShortageSlotWUName
SumFlowsToVolumeSkipNaN
Min
Max
CompletePartialDate
PreviousDate
NumberToDate
GetDates
NextDate
FlowToVolume
GetRunCycleIndex
HasRuleFiredSuccessfully
VolumeToFlow

4.4.3 RC4 - March 1 of Shortage Years Only - Reduce M&I and NIIP Demands for Shortage - Proportional Reduction of Diversion Request

Statements

Execution Constraint

Referenced Functions

ShortageSlotWUName
SumFlowsToVolumeSkipNaN
Max
CompletePartialDate
NumberToDate
GetDates
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.4.4 RC4 - March 1 of Shortage Years Only - Apply Shortage to SJC

Statements

Execution Constraint

Referenced Functions

Min
SumFlowsToVolume
Max
CompletePartialDate
PreviousDate
NumberToDate
GetDates
NextDate
FlowToVolume
GetRunCycleIndex
HasRuleFiredSuccessfully
VolumeToFlow

4.4.5 TURN ON WHEN NEEDED ----- RC4 - March 1 of Shortage Years Only - EXTEND SHORTAGES TO NEXT YEAR IF NEEDED - Adjust Shortage Percentage and Volumes Based on Current Storage Deviation

Statements

Execution Constraint

Referenced Functions

ShortageSlotWUName
Min
Max
CompletePartialDate
NumberToDate
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.4.6 RC4 STO - Calculate Shortage Volumes by Users

Statements

Execution Constraint

Referenced Functions

ShortageSlotWUName
Min
Max
CompletePartialDate
NumberToDate
GetDates
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.4.7 RC4 STO - Calculate Shortage Percentage

Statements

Execution Constraint

Referenced Functions

ShortageSlotWUName
Min
GetDates
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.4.8 RC4 STO - Sum Annual Shortage and Shortage Sharing Water User Diversion Volumes

Statements

Execution Constraint

Referenced Functions

ShortageSlotWUName
SumFlowsToVolumeSkipNaN
CompletePartialDate
NumberToDate
GetDates
NextDate
FlowToVolume
GetRunCycleIndex
HasRuleFiredSuccessfully

4.5 Navajo Ops - Cycle 3

4.5.1 Run Cycle 3 Final Timestep Only - Save Cycle 3 Navajo Ops

Statements

Execution Constraint

Referenced Functions

GetDates
GetRunCycleIndex

4.5.2 Set Navajo Cycle 3 Release - With Supplemental Water

Statements

Execution Constraint

Referenced Functions

MaxItem
Min
MinItem
GetMaxReleaseGivenInflow
SolveInflow
SolveStorage
ElevationToStorage
GetRunCycleIndex
TableInterpolation
HasRuleFiredSuccessfully
StorageToElevation

4.5.3 Cycle 3 Calculate Downstream Flood Control Limited Navajo Release

Statements

Execution Constraint

Referenced Functions

MaxItem
Min
Max
GetMaxReleaseGivenInflow
HypSim
HypTargetSimWithStatus
GetRunCycleIndex
GetObject
ColumnLabels
TableInterpolation
HasRuleFiredSuccessfully

4.5.4 Cycle 3 Calculate Navajo Flood Control Release

Computes Navajo release to meet demands with baseflow bypasses set.

Statements

Execution Constraint

Referenced Functions

MaxItem
Min
Max
GetMinSpillGivenInflowRelease
GetMaxReleaseGivenInflow
SolveStorage
SolveOutflow
GetRunCycleIndex
TableInterpolation
HasRuleFiredSuccessfully

4.5.5 Cycle 3 Calculate Navajo Flood Control Storage

Computes Navajo release to meet demands with baseflow bypasses set.

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolume
Max
GetDates
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.5.6 Cycle 3 Calculate Navajo Release Demand With Baseflow Requirements

Computes Navajo release to meet demands with baseflow bypasses set.

Statements

Execution Constraint

Referenced Functions

NetSubBasinDiversionRequirement
ListDownstreamObjects
GetRunCycleIndex
HasRuleFiredSuccessfully

4.5.7 Cycle 3 Set Downstream Baseflow Requirements - Three Gage Average

Sets engineering slot values from data object slot values.

Statements

Execution Constraint

Referenced Functions

ThreeGageBypassesNEW
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6 Old Flow Recs - 1996 BO Flow Recommendations Operations

4.6.1 Set Old Flushing Release as Release Schedule

Statements

Execution Constraint

Referenced Functions

GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.2 1996 BO Flow Recs Nose Adjusted Release

Statements

Execution Constraint

Referenced Functions

MakeListOfDatesAndValues
FlushingStartDate
ComputeNoseAdjustedRelease
GetDates
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.3 1996 BO Flow Recs Compute Excess Water

Statements

Execution Constraint

Referenced Functions

ComputedExcessFlushingVolume
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.4 1996 BO Flow Recs Store Unadjusted Flushing Release

Computes unadjusted flushing release and stores in a interim slot.

Statements

Execution Constraint

Referenced Functions

MakeListOfDatesAndValues
MakeUnadjustedFlowList
GetDates
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.5 1996 BO Flow Recs Set Last Pattern

Statements

Execution Constraint

Referenced Functions

GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.6 1996 BO Flow Recs Set Pattern

Statements

Execution Constraint

Referenced Functions

IncrementalFlushingVolume
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.7 1996 BO Flow Recs Set Last Release Type and Water Supply

Statements

Execution Constraint

Referenced Functions

GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.8 1996 BO Flow Recs Set Release Type

Statements

Execution Constraint

Referenced Functions

Gen2GetReleaseTypeGivenPath
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.9 1996 BO Flow Recs Set Last Path

Statements

Execution Constraint

Referenced Functions

GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.10 1996 BO Flow Recs Path 16 Longterm Lookback At Four Corners

Looks at Stateline gains flows for past n years and if sum of May and June
less than threshold (LookbackVolume) and release keeps Navajo ok,
make a maximum release. This is path 16 in pattern setting.

Statements

Execution Constraint

Referenced Functions

Gen2GetReleaseTypeGivenPath
SumFlowValueToVolume
GageWasShortInMayAndJune
EstimatedEndOfPeriodNavajoContent
IncrementalFlushingVolume
GetMonthAsString
GetRunCycleIndex
HasRuleFiredSuccessfully
StorageToElevation

4.6.11 1996 BO Flow Recs Path 17 Short Term Lookback At Four Corners

Looks at Stateline gains flows for past n years and if sum of May and June
less than threshold (LookbackVolume) and release keeps Navajo ok,
make a specified release. This is path 17 in pattern setting.

Statements

Execution Constraint

Referenced Functions

Gen2GetReleaseTypeGivenPath
SumFlowValueToVolume
GageWasShortInMayAndJune
EstimatedEndOfPeriodNavajoContent
IncrementalFlushingVolume
GetMonthAsString
GetRunCycleIndex
HasRuleFiredSuccessfully
StorageToElevation

4.6.12 1996 BO Flow Recs Set Decision Tree Path

Statements

Execution Constraint

Referenced Functions

Gen2SetFlushingFlowsPath
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.13 1996 BO Flow Recs Compute Water Available

Statements

Execution Constraint

Referenced Functions

TotalAvailableWaterBySlotNoErr
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.14 1996 BO Flow Recs Estimate Probable Spill

Statements

Execution Constraint

Referenced Functions

SurplusVolumeBySlotNoErr
GetRunCycleIndex
HasRuleFiredSuccessfully

4.6.15 Compute Model Perturbations (and Optionally Apply Them Instead of Using Historic)

Statements

Execution Constraint

Referenced Functions

CountPerturbationEventsLAG
CountPerturbationEventsNOLAG
GetYear
GetRunCycleIndex

4.7 RUN C - 2016 Flow Recommendation Analysis Rules - REMEMBER TO SET EOWYST SLOT TO 6050

4.7.1 RUN C - Sum SPR Schedule Volumes

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolume
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.7.2 RUN C - Make Final SPR Schedule, Add Non Nose Excess

Statements

Execution Constraint

Referenced Functions

Min
Floor
Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.7.3 RUN C - Shift SPR Schedule to Match Animas Peak

Statements

Execution Constraint

Referenced Functions

Min
Max
DateMin
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.7.4 RUN C - Find Animas Peak

Statements

Execution Constraint

Referenced Functions

MaxItem
GetDatesCentered
GetDates
GetRunCycleIndex
HasRuleFiredSuccessfully

4.7.5 RUN C - Extend 5000 cfs Nose, Make Base and Nose Schedule

Statements

Execution Constraint

Referenced Functions

Floor
Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.7.6 RUN C - Make Run C Spring Peak Release Schedule - Fill 5000 cfs days

Statements

Execution Constraint

Referenced Functions

Floor
Max
Ceiling
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.7.7 RUN C - Make Run C Initial Spring Peak Release Schedule

Statements

Execution Constraint

Referenced Functions

Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.7.8 RUN C - Set Release Type, Volume, Calc Excess Water, Calc Nose Volume, Etc

Statements

Execution Constraint

Referenced Functions

Min
Max
ElevationToStorage
GetRunCycleIndex
HasRuleFiredSuccessfully

4.7.9 RUN C - RC1 STO - Verify EOWYST Value and SJRIP Release Setup

Statements

Execution Constraint

Referenced Functions

Abs
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8 RUN C with MAINTENANCE RELEASES - 2016 Flow Recommendation Analysis Rules - REMEMBER TO SET EOWYST SLOT TO 6050

4.8.1 RUN C - Sum SPR Schedule Volumes

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolume
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.2 RUN C - Make Final SPR Schedule, Add Non Nose Excess

Statements

Execution Constraint

Referenced Functions

Min
Floor
Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.3 MRs - Make and Insert Maintenance Release Schedule

Statements

Execution Constraint

Referenced Functions

Floor
GetNumbers
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.4 RUN C - Shift SPR Schedule to Match Animas Peak

Statements

Execution Constraint

Referenced Functions

Min
Max
DateMin
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.5 RUN C - Find Animas Peak

Statements

Execution Constraint

Referenced Functions

MaxItem
GetDatesCentered
GetDates
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.6 RUN C - Extend 5000 cfs Nose, Make Base and Nose Schedule

Statements

Execution Constraint

Referenced Functions

Floor
Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.7 RUN C - Make Run C Spring Peak Release Schedule - Fill 5000 cfs days

Statements

Execution Constraint

Referenced Functions

Floor
Max
Ceiling
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.8 RUN C - Make Run C Initial Spring Peak Release Schedule

Statements

Execution Constraint

Referenced Functions

Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.9 RUN C with MRs - Set Release Type, Volume, Calc Excess Water, Calc Nose Volume, Etc

Statements

Execution Constraint

Referenced Functions

DetermineMRReleases
Min
Max
ElevationToStorage
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.10 RUN C - RC1 STO - Verify EOWYST Value and SJRIP Release Setup

Statements

Execution Constraint

Referenced Functions

Abs
GetRunCycleIndex
HasRuleFiredSuccessfully

4.8.11 Compute Model Perturbations (and Optionally Apply Them Instead of Using Historic)

Statements

Execution Constraint

Referenced Functions

CountPerturbationEventsLAG
CountPerturbationEventsNOLAG
GetYear
GetRunCycleIndex

4.9 RUN B - 2016 Flow Recommendation Analysis Rules - REMEMBER TO SET EOWYST SLOT TO 6050

4.9.1 RUN B - Sum SPR Schedule Volumes

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolume
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.9.2 RUN B - Make Final SPR Schedule, Add Non Nose Excess

Statements

Execution Constraint

Referenced Functions

Min
Floor
Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.9.3 RUN B - Add Base and Nose Schedules

Statements

Execution Constraint

Referenced Functions

Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.9.4 RUN B - Make Nose Schedule

Statements

Execution Constraint

Referenced Functions

Min
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.9.5 RUN B - Make Base Spring Peak Release Schedule

Statements

Execution Constraint

Referenced Functions

NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.9.6 RUN B - Set Release Type, Volume, Calc Excess Water, Calc Nose Volume, Etc

Statements

Execution Constraint

Referenced Functions

Max
ElevationToStorage
GetRunCycleIndex
HasRuleFiredSuccessfully
TableLookupDefaultTol

4.9.7 RUN B - RC1 STO - Verify EOWYST Value

Statements

Execution Constraint

Referenced Functions

Abs
GetRunCycleIndex
HasRuleFiredSuccessfully

4.10 RUN A - 2016 Flow Recommendation Analysis Rules - REMEMBER TO SET EOWYST SLOT TO 6063

4.10.1 RUN A - Sum SPR Schedule Volumes

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolume
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.10.2 RUN A - Make Final SPR Schedule, Add Non Nose Excess

Statements

Execution Constraint

Referenced Functions

Min
Floor
Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.10.3 RUN A - Add Base and Nose Schedules

Statements

Execution Constraint

Referenced Functions

Max
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.10.4 RUN A - Make Nose Schedule

Statements

Execution Constraint

Referenced Functions

Min
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.10.5 RUN A - Make Base Spring Peak Release Schedule

Statements

Execution Constraint

Referenced Functions

NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.10.6 RUN A - Set Release Type, Volume, Calc Excess Water, Calc Nose Volume, Etc

Statements

Execution Constraint

Referenced Functions

Min
Max
GetRunCycleIndex
HasRuleFiredSuccessfully
TableLookupDefaultTol

4.10.7 RUN A - RC1 STO - Verify EOWYST Value

Statements

Execution Constraint

Referenced Functions

Abs
GetRunCycleIndex
HasRuleFiredSuccessfully

4.11 2016 Flow Recommendations - Available Water Calculation Rules - Cycle 3

4.11.1 Compute Available Water

Statements

Execution Constraint

Referenced Functions

Max
ElevationToStorage
GetRunCycleIndex
HasRuleFiredSuccessfully
StorageToElevation

4.11.2 Sum Required Daily Releases to Meet Target Baseflow from Run Cycle 2

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolume
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.11.3 Estimate Flow Volumes for Available Water Calcs

Statements

Execution Constraint

Referenced Functions

EstimateEvaporation
SumPeriodicFlowToVolume
SumFlowsToVolume
PreviousDate
NextDate
ElevationToArea
GetRunCycleIndex
HasRuleFiredSuccessfully
StorageToArea

4.12 Navajo Target Baseflow Ops - Cycle 2

4.12.1 Run Cycle 2 Final Timestep Only - Save Cycle 2 Navajo Ops

Statements

Execution Constraint

Referenced Functions

GetDates
GetRunCycleIndex

4.12.2 Calc and Set Navajo Cycle 2 Release

Statements

Execution Constraint

Referenced Functions

Min
GetMaxReleaseGivenInflow
NetSubBasinDiversionRequirement
ListDownstreamObjects
GetRunCycleIndex
TableInterpolation
HasRuleFiredSuccessfully

4.12.3 Set Downstream Baseflow Requirements - Three Gage Average

Sets engineering slot values from data object slot values.

Statements

Execution Constraint

Referenced Functions

ThreeGageBypassesNEW
GetRunCycleIndex
HasRuleFiredSuccessfully

4.13 ALP Normal Operations - Cycle 2

4.13.1 Stop Run if StateMod Diversions Aren't Met

Statements

Execution Constraint

Referenced Functions

GetRunCycleIndex

4.13.2 Set Ridges Basin Release

Statements

Execution Constraint

Referenced Functions

Max
MinItem
ListSubbasin
GetMaxReleaseGivenInflow
SolveOutflow
GetRunCycleIndex
HasRuleFiredSuccessfully

4.13.3 Set Final Supply To RBR Diversions

Statements

Execution Constraint

Referenced Functions

Abs
Min
Max
SolveOutflow
GetRunCycleIndex
HasRuleFiredSuccessfully

4.13.4 Set Remaining ALPDurango Demand from RBR

Statements

Execution Constraint

Referenced Functions

Max
GetRunCycleIndex
HasRuleFiredSuccessfully

4.13.5 Calculate and Set Durango and RBR Pumping

Computes available for diversion (pumping) for normal ALP operation.

Statements

Execution Constraint

Referenced Functions

Min
Max
MinItem
ListSubbasin
SolveInflow
GetMonthAsString
NetSubBasinDiversionRequirement
ListDownstreamObjects
GetRunCycleIndex
HasRuleFiredSuccessfully

4.13.6 Set Initial Supply To RBR Diversions

Statements

Execution Constraint

Referenced Functions

Min
Max
SolveOutflow
GetRunCycleIndex
HasRuleFiredSuccessfully

4.13.7 Initially Set ALP/RBR Operations to Zeros

Statements

Execution Constraint

Referenced Functions

GetRunCycleIndex
HasRuleFiredSuccessfully

4.14 Reoperate San Juan Chama - Cycle 1

4.14.1 Run Cycle 1 and 4 Final Timestep Only - Sum San Juan Chama Diversion Volumes

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolumeSkipNaN
PreviousDate
GetDates
NextDate
GetRunCycleIndex

4.14.2 Run Cycle 1 Final Timestep Only - Verify Mass Balance for Applied SJC Adjustments

Statements

Execution Constraint

Referenced Functions

Abs
SumFlowsToVolume
GetDates
NextDate
GetRunCycleIndex

4.14.3 Run Cycle 1 Final Timestep Only - SJC StateMod Adjustment

Statements

Execution Constraint

Referenced Functions

EndOfMonthDate
SumFlowsToVolume
GetDaysInMonth
GetDates
NextDate
FlowToVolume
GetRunCycleIndex
VolumeToFlow

4.14.4 Accumulate Monthly Annual and Decade Totals

Sets Heron Outflow as a function of demand and shortages.

Statements

Execution Constraint

Referenced Functions

EndOfYearDate
SumFlowsToVolumeSkipNaN
PreviousDate
NextDate
FlowToVolume
GetRunCycleIndex
HasRuleFiredSuccessfully

4.14.5 Limit SJC Oso Diversion Request

Statements

Execution Constraint

Referenced Functions

Max
MinItem
GetRunCycleIndex
HasRuleFiredSuccessfully

4.14.6 Limit SJC Little Oso Diversion Request

Statements

Execution Constraint

Referenced Functions

Max
MinItem
GetRunCycleIndex
HasRuleFiredSuccessfully

4.14.7 Limit SJC Blanco Diversion Request

Statements

Execution Constraint

Referenced Functions

MinItem
GetRunCycleIndex
HasRuleFiredSuccessfully

4.14.8 Calculate Heron Inflow Limit and SJC Annual and Decade Limits

Statements

Execution Constraint

Referenced Functions

HeronClimateChangeAdjustmentFactor
SJCAnnualLimit
EndOfMonthDate
SJCDecadeLimit
SumFlowsToVolume
Max
PreviousDate
SolveInflow
NextDate
ElevationToStorage
GetRunCycleIndex
HasRuleFiredSuccessfully
VolumeToFlow

4.14.9 Set Heron Outflow

Sets Heron Outflow as a function of demand and shortages.

Statements

Execution Constraint

Referenced Functions

HeronClimateChangeAdjustmentFactor
MinItem
GetMaxReleaseGivenInflow
SolveOutflow
GetRunCycleIndex
TableInterpolation
HasRuleFiredSuccessfully

4.15 REIMPLEMENT THIS ------- Refiring Rules

4.15.1 REFIRING - RESET IAWs AS NEEDING TO FORCE DISPATCHING or however to get it to work...

Sets Heron Outflow as a function of demand and shortages.

Statements

4.16 Start Timestep Only Rules

4.16.1 RC2 STO - Pattern Enterprise and Pioneer Diversions by StateMod Supply

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolumeSkipNaN
Min
PreviousDate
DateMin
DateMax
GetDates
NextDate
FlowToVolume
GetRunCycleIndex
HasRuleFiredSuccessfully
VolumeToFlow

4.16.2 RC1 STO - Sum and Check Adjusted Tribal Irrigation Demand Volumes

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolumeSkipNaN
PreviousDate
GetDates
NextDate
GetRunCycleIndex
HasRuleFiredSuccessfully

4.16.3 RC1 STO - Adjust Tribal Acres and Demands based on Decreed Maximum Volumes

Statements

Execution Constraint

Referenced Functions

SumFlowsToVolumeSkipNaN
Min
Sum
Max
PreviousDate
GetDates
NextDate
FlowToVolume
GetRunCycleIndex
HasRuleFiredSuccessfully

4.17 Generic Functions

Functions that support generic rule set.

4.17.1 EstimateEvaporation

Estimates furture reservoir evaporation form startDate (usually current time step)
thru endDate. Additional argument of meanArea is estimated average surface
area during interval.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC meanArea
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

GetDayOfYear
TableInterpolation

4.17.2 GetMeanArea

Computes mean surface area for 2 storage values.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC startStorage
NUMERIC endStorage

Body

Referenced Functions

StorageToArea

4.17.3 PreviousElevation

Returns previous elevation of reservoir.

Return Type: NUMERIC

Arguments:

OBJECT reservoir

Body

4.17.4 PreviousStorage

Returns previous storage of reservoir.

Return Type: NUMERIC

Arguments:

OBJECT reservoir

Body

4.17.5 FindFlowGivenDateFromLists

Returns flow for given date from a lists of flows and dates.

Return Type: NUMERIC

Arguments:

DATETIME date
LIST flowsList
LIST datesList

Body

4.17.6 InsertDateValueSetIntoList

Inserts a date and value set into a list of flows and dates.

Return Type: LIST

Arguments:

DATETIME date
NUMERIC value

Body

4.17.7 MakeForLoopList

Makes a list of indeces for use in a For Loop.

Return Type: LIST

Arguments:

NUMERIC numberIndices

Body

4.17.8 MakeListGivenValuePoints

Make a list of values for a given value and number of points.

Return Type: LIST

Arguments:

NUMERIC valueToList
NUMERIC numberPoints

Body

Referenced Functions

MakeForLoopList

4.17.9 MakeListOfDatesAndValues

Returns a list of dates and values.

Return Type: LIST

Arguments:

LIST values
LIST dates

Body

Referenced Functions

MakeForLoopList
InsertDateValueSetIntoList

4.17.10 StringDay

Returns a string version of day of month given diminsionless day of month.

Return Type: STRING

Arguments:

NUMERIC day

Body

4.17.11 StringMonth

Returns string month given month.

Return Type: STRING

Arguments:

NUMERIC month

Body

4.17.12 DateIsBetween

Checks if dateA falls between dateB and dateC inclusively.

Return Type: BOOLEAN

Arguments:

DATETIME dateA
DATETIME dateB
DATETIME dateC

Body

4.17.13 EndOfMonthDate

Returns end of month date given date.

Return Type: DATETIME

Arguments:

DATETIME dateTime

Body

Referenced Functions

NextDate

4.17.14 EndOfYearDate

Return Type: DATETIME

Arguments:

DATETIME dateTime

Body

Referenced Functions

NextDate

4.17.15 SumDailyFlowsInListToVolume

Sums daily flows in provided list to a volume.

Return Type: NUMERIC

Arguments:

LIST listToSum

Body

Referenced Functions

4.17.16 SumFlowValueToVolume

Sum specified flow value to a volume for specified time period.

Return Type: NUMERIC

Arguments:

DATETIME startDate
DATETIME endDate
NUMERIC valueToSum

Body

Referenced Functions

FlowToVolume

4.17.17 SumPeriodicFlowToVolume

Sums a periodic slot flow to a volume for specified time period.

Return Type: NUMERIC

Arguments:

SLOT slot
DATETIME startDate
DATETIME endDate
STRING column

Body

Referenced Functions

FlowToVolume

4.18 New Functions

4.18.1 ThreeGageBypassesNEW

Computes bypass flows using the three gage criteria.

Return Type: LIST

Arguments: None

Body

Referenced Functions

Min
Max
CompletePartialDate
NumberToDate
GetDates
NextDate
FlowToVolume
GetRunCycleIndex

4.18.2 ShortageSlotWUName

Return Type: STRING

Arguments:

OBJECT wu

Body

Referenced Functions

Split

4.18.3 DetermineMRReleases

Return Type: LIST

Arguments:

NUMERIC reltype
NUMERIC AW

Body

Referenced Functions

Sum
Max
PreviousDate
ElevationToStorage
GetSlotVals
ColumnLabels
TableLookupDefaultTol

4.19 San Juan Chama Functions

4.19.1 SJCAnnualLimit

Computes maximum inflow that Heron can receive given expected release and current storage conditions.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

Max
VolumeToFlow

4.19.2 SJCDecadeLimit

Computes maximum inflow that Heron can receive given expected release and current storage conditions.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

SJCDecadeTotal
Max
VolumeToFlow

4.19.3 SJCDecadeTotal

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

EndOfYearDate
OffsetDate
GetDates

4.20 Old Flow Recs Functions

4.20.1 Gen2GetReleaseTypeGivenPath

Get flushing flows release type given path, spill, and available water.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
IncrementalFlushingVolume
Max

4.20.2 Gen2SetFlushingFlowsPath

Sets path by 1996 BO Flow Recseration decision tree.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

IncrementalFlushingVolume
GetHistoricReleaseVolumes
MaxItem

4.20.3 TotalExcessVolumes

Makes a list of total excess volumes.
NOTE - I believe that BV has an error, or at least an inconsistency, between
the pre flushing release period and the during flushing release period.
He limits the during period to the peak release here whereas he does not
limit the pre flushing release here. DLK

Return Type: LIST

Arguments:

NUMERIC releaseType
DATETIME flushingStartDate
DATETIME periodStartDate

Body

Referenced Functions

AdditionalNoseWater
PreFlushingReleaseNoseWater
IncrementalExcessFlows

4.20.4 TotalFlushingVolume

Computes total flushing volume given release type.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

MakeForLoopList
GetFlowDurationSlot

4.20.5 RowsInFlowDurationTable

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

GetFlowDurationSlot

4.20.6 PreFlushingReleaseNoseWater

Computes volume of nose water prior to flushing release.

Return Type: NUMERIC

Arguments:

NUMERIC incrementalRelease
DATETIME flushingStartDate
DATETIME periodStartDate

Body

Referenced Functions

MakeListGivenValuePoints
SumDailyFlowsInListToVolume
GetJulianDate

4.20.7 PerturbationOccurred_REMOVED

Returns true if a perturbation occurred.

Return Type: BOOLEAN

Arguments: None

Body

4.20.8 PerturbationGainsLAG

Computes gains as per perturbation computations with default lagging.

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

OffsetDate

4.20.9 PerturbationGainsNOLAG

Computes gains as per perturbation computations with default lagging.

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

4.20.10 OddDaysPeakDuration

Returns peak duration adjusted to always be an odd number of unitless days.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

FlushingPeakDuration
FlushingPeakElement

4.20.11 NavajoDescendingLimit

Constrains flow for descending case.

Return Type: NUMERIC

Arguments:

NUMERIC previousFlow

Body

Referenced Functions

4.20.12 NavajoAscendingLimit

Constrains flow for ascending case.

Return Type: NUMERIC

Arguments:

NUMERIC previousFlow

Body

Referenced Functions

4.20.13 MaximumReleaseType

Computes maximum release type given supply.

Return Type: NUMERIC

Arguments:

NUMERIC supply

Body

Referenced Functions

IncrementalFlushingVolume

4.20.14 MakeUnadjustedFlowList

Make list of flows as a hydrograph without nose water integrated with minimum release.

Return Type: LIST

Arguments:

NUMERIC releaseType
LIST modelDates

Body

Referenced Functions

FindFlowGivenDateFromLists
DateIsBetween
FlushingEndDate
FlushingStartDate
MakeNoExcessFlowList
GetDates

4.20.15 AdditionalNoseWater

Computes additonal water volume as flushing hydrograph is encountered.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType
NUMERIC noseFlow

Body

Referenced Functions

MakeListGivenValuePoints
MakeForLoopList
SumDailyFlowsInListToVolume
FlushingPeakFlow
FlushingPeakElement
FlushingFlowsToPeak
FlushingDurationsToPeak
Min

4.20.16 AdjustedEndDate

Returns flushing release start date from actual hydrograph.

Return Type: DATETIME

Arguments:

SLOT slot

Body

Referenced Functions

FlushingCenterDate
OffsetDate
GetDates

4.20.17 AdjustedStartDate

Returns flushing release end date from actual hydrograph.

Return Type: DATETIME

Arguments:

SLOT slot

Body

Referenced Functions

GetDates

4.20.18 ApplyAverageNoseRelease

Applies average nose release to flushing flows.

Return Type: LIST

Arguments:

NUMERIC releaseType
DATETIME flushingStartDate
LIST flushingDates
SLOT slot
BOOLEAN rampingFlag

Body

Referenced Functions

NavajoDescendingLimit
NavajoAscendingLimit
AverageNoseRelease
FlushingCenterDate
Min
Max
OffsetDate

4.20.19 AverageNoseRelease

Computes average nose release given excess volume that is available.
Returns a default flow when no excess water is available or we do not meet
the minimum.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType
DATETIME flushingStartDate
DATETIME periodStartDate

Body

Referenced Functions

BracketExcessFlowGivenExcessVolume
FlushingPeakFlow

4.20.20 BracketExcessFlowGivenExcessVolume

Given excess volume available for nose water, locate it in incremental volumes list
and return equivalent flow.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType
DATETIME flushingStartDate
DATETIME periodStartDate

Body

Referenced Functions

MakeForLoopList
TotalExcessVolumes
IncrementalExcessFlows

4.20.21 CountPerturbationEventsLAG

Counts number of events that meet perturbation criteria.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

PerturbationGainsLAG
Sum
DateMin
GetDates
GetSlotVals

4.20.22 CountPerturbationEventsOLDwERRORS

Counts number of events that meet perturbation criteria.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

Sum
DateMin
GetDates
GetSlotVals

4.20.23 CountPerturbationEventsNOLAG

Counts number of events that meet perturbation criteria.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

PerturbationGainsNOLAG
Sum
DateMin
GetDates
GetSlotVals

4.20.24 ComputedExcessFlushingVolume

Computes water not required to meet the incremental volume required by a given flushing release.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType
NUMERIC predictedSpill

Body

Referenced Functions

AdjustedStartDate
IncrementalFlushingVolume
FlushingStartDate
Max

4.20.25 ComputeNoseAdjustedRelease

Computes Nose Adjusted Release

Return Type: LIST

Arguments:

DATETIME flushingStartDate
NUMERIC releaseType
SLOT slot
LIST modelDates
BOOLEAN rampingFlag

Body

Referenced Functions

FindFlowGivenDateFromLists
DateIsBetween
ApplyAverageNoseRelease
AdjustedEndDate
FlushingEndDate
GetDates
GetSlotVals

4.20.26 EstimatedEndOfPeriodNavajoContent

Estimates end of period Navajo content given anticipated release volume.

Return Type: NUMERIC

Arguments:

NUMERIC anticipatedRelease
DATETIME endDate

Body

Referenced Functions

PreviousElevation
EstimateEvaporation
PreviousStorage
SumFlowsToVolumeSkipNaN
SumFlowsToVolume
Max
ElevationToArea

4.20.27 FlushingAccumulatedDurations

Returns a list of accumulated durations for the flushing flows.

Return Type: LIST

Arguments:

NUMERIC releaseType

Body

Referenced Functions

MakeForLoopList
RowsInFlowDurationTable
GetFlowDurationSlot

4.20.28 FlushingCenterDate

Return Type: DATETIME

Arguments: None

Body

Referenced Functions

StringDay
StringMonth
GetDate

4.20.29 FlushingDownrampDuration

Returns unitless days of down ramp duration.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

RowsInFlowDurationTable
GetFlowDurationSlot
FlushingPeakElement
SumTableColumn

4.20.30 FlushingDuration

Returns total duration of flushing release.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

RowsInFlowDurationTable
GetFlowDurationSlot
SumTableColumn

4.20.31 FlushingDurationsToPeak

Return Type: LIST

Arguments:

NUMERIC releaseType

Body

Referenced Functions

GetFlowDurationSlot
FlushingPeakElement
GetTableColumnVals

4.20.32 FlushingEndDate

Return Type: DATETIME

Arguments:

NUMERIC releaseType

Body

Referenced Functions

OddDaysPeakDuration
FlushingDownrampDuration
FlushingCenterDate
Floor
OffsetDate

4.20.33 FlushingPeakFlow

Gets peak flow in flow duration table as a list.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

GetFlowDurationSlot

4.20.34 FlushingPeakDuration

Returns unitless days of peak duration unadjusted for odd number of days check.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

GetFlowDurationSlot
FlushingPeakElement

4.20.35 FlushingFlowsToPeak

Return Type: LIST

Arguments:

NUMERIC releaseType

Body

Referenced Functions

GetFlowDurationSlot
FlushingPeakElement
GetTableColumnVals

4.20.36 FlushingPeakElement

Finds element in flow duration flows list where max flow is encountered.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

GetFlowDurationSlot

4.20.37 FlushingStartDate

Return Type: DATETIME

Arguments:

NUMERIC releaseType

Body

Referenced Functions

OddDaysPeakDuration
FlushingCenterDate
FlushingUprampDuration
Floor
OffsetDate

4.20.38 FlushingUprampDuration

Returns number of unitless days in up ramp portion of hydrograph.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

GetFlowDurationSlot
FlushingPeakElement
SumTableColumn

4.20.39 GageWasShortInMayAndJune

Determines if a gage was short of lookup back volume for past n years for May and June.

Return Type: NUMERIC

Arguments:

STRING row
SLOT slot

Body

Referenced Functions

MakeForLoopList
SumFlowsToVolumeSkipNaN

4.20.40 GetFlowDurationSlot

Returns slot name of flow duration table given release type.

Return Type: SLOT

Arguments:

NUMERIC releaseType

Body

4.20.41 GetFlowGivenDayFromFlowDurationTable

Given a day of interest, return flow from flushing flows flow duration table.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType
NUMERIC dayOfInterest

Body

Referenced Functions

MakeForLoopList
RowsInFlowDurationTable
GetFlowDurationSlot
FlushingAccumulatedDurations
GetTableColumnVals

4.20.42 GetHistoricReleaseVolumes

Return Type: LIST

Arguments:

NUMERIC numberYears

Body

Referenced Functions

MakeForLoopList
OffsetDate

4.20.43 IncrementalExcessFlows

Returns list of excess flows incremented by specified amount.

Return Type: LIST

Arguments:

NUMERIC releaseType

Body

Referenced Functions

FlushingPeakFlow
GetNumbers

4.20.44 IncrementalFlushingVolume

Computes incremental flushing volume.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

AdjustedStartDate
SumPeriodicFlowToVolume
AdjustedEndDate
TotalFlushingVolume
FlushingEndDate
FlushingStartDate
SumFlowsToVolumeSkipNaN
Max

4.20.45 MakeNoExcessFlowList

Make list of flows as a hydrograph without nose water.

Return Type: LIST

Arguments:

NUMERIC releaseType

Body

Referenced Functions

MakeForLoopList
GetFlowGivenDayFromFlowDurationTable
FlushingDuration

4.20.46 ComputeAvailableSpace

Computes available in reservoir in reference to target elevation of day or month.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME datetime

Body

Referenced Functions

PreviousStorage
DailyTargetStorage

4.20.47 DailyTargetStorage

Computes daily target storage as a function of daily target elevation.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME datetime

Body

Referenced Functions

ElevationToStorage

4.20.48 SurplusVolumeBySlotNoErr

Computes surplus volume for a reservoir by slot with no forecast error applied.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
ComputeAvailableSpace
SumFlowsToVolumeSkipNaN
Max

4.20.49 TotalAvailableWaterBySlotNoErr

Computes total available water (surplus plus storage less reserve).

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
SumFlowsToVolumeSkipNaN
Max

4.21 Archived StateMod Functions

This utility group is used to support the special cases and evaporation adjustment
policy groups.

4.21.1 ActualIncidentalLoss

Computes actual incidental loss as a flow as a function of return flow and lagging pattern.

Return Type: NUMERIC

Arguments:

OBJECT waterUser
DATETIME datetime

Body

4.21.2 IncidentalLossRateByLagging

Looks up incidental loss rate as a function of water user and delay pattern.

Return Type: NUMERIC

Arguments:

OBJECT waterUser

Body

Referenced Functions

TableInterpolation

4.21.3 PeriodSubbasinIncLossVolume

Computes subbasin incidental loss volume over specified period.

Return Type: NUMERIC

Arguments:

BOOLEAN requested
STRING subbasin
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

GetDates

4.21.4 PeriodWaterUserIncLossVolume

Computes water incidental loss volume for a period.

Return Type: NUMERIC

Arguments:

BOOLEAN requested
OBJECT waterUser
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

GetDates
FlowToVolume

4.21.5 RequestedIncidentalLoss

Computes requested incidental loss as a flow as a function of return flow and lagging pattern.

Return Type: NUMERIC

Arguments:

OBJECT waterUser
DATETIME datetime

Body

4.21.6 SubbasinIncidentalLossVolume

Computes incidental loss volume for a basin given scenario and subbasin name.

Return Type: NUMERIC

Arguments:

BOOLEAN requested
STRING subbasin
DATETIME datetime

Body

Referenced Functions

ListSubbasin
FlowToVolume
FilterByObjType

4.22 Archived 1996 BO Flow Reccommendations Functions

Functions needed to use 1996 BO Flow Recseration operation.

4.22.1 Interim1G2GetReleaseTypeGivenPath

No release type 1 releases with incremented releases.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
IncrementalFlushingVolume
Max

4.22.2 Interim2G2GetReleaseTypeGivenPath

No release type 1. Maximum release for predicted spill otherwise.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
IncrementalFlushingVolume
Max

4.22.3 Interim3G2GetReleaseTypeGivenPath

No release type 1 but some release if sufficient predicted spill.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
IncrementalFlushingVolume
Max

4.22.4 Interim4G2GetReleaseType

All release type 5 if sufficient spill and not path 17.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

IncrementalFlushingVolume

4.22.5 Interim2G3GetReleaseTypeGivenPath

No release type 1. Maximum release for predicted spill otherwise.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
IncrementalFlushingVolume
Min
Max

4.22.6 Interim3G3GetReleaseTypeGivenPath

No release type 1 but some release if sufficient predicted spill.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
IncrementalFlushingVolume
Min
Max

4.22.7 Interim4G3GetReleaseType

All release type 5 if sufficient spill.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

IncrementalFlushingVolume

4.22.8 NavajoRegressionRelease

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

PreviousStorage
GetDaysInMonth
GetMonthAsString
DateMax
VolumeToFlow

4.22.9 SumUpstreamFill

Computes available space of all upstream reservoirs.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

ListSubbasin
GetMonth
FilterByObjType

4.22.10 AddUpstreamFill

Computes available space in reservoirs in list.

Return Type: NUMERIC

Arguments:

LIST listOfReservoirs
DATETIME datetime

Body

Constraints

Referenced Functions

PreviousStorage
DailyTargetStorage

4.22.11 HydrologicInflowVolumeBySlotNoErr

Computes hydrologic inflow forecast volume by slot to a reservoir without any forecast error applied.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT slot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

Max
SumSlotSkipNaN

4.22.12 ExcessDays

Return Type: NUMERIC

Arguments:

NUMERIC excessVolume
NUMERIC peakFlow

Body

Referenced Functions

Mod
Ceiling

4.22.13 EventWasMade

Returns true is specified event as occurred in current year.

Return Type: BOOLEAN

Arguments:

NUMERIC eventType

Body

Referenced Functions

AnnualEventLastOccurrence

4.22.14 MinimumSanJuanFlow

Computes minimum of average daily flows of San Juan of four references gages.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

MinItem

4.22.15 RunoffSeason

Return Type: BOOLEAN

Arguments: None

Body

4.23 Archived Navajo Functions

4.23.1 AdjustedPeakBeginDate

Returns adjusted flushing release peak begin date.

Return Type: DATETIME

Arguments:

SLOT slot

Body

Referenced Functions

AdjustedStartDate
AdjustedEndDate
FlushingPeakFlow
GetDates

4.23.2 AdjustedPeakEndDate

Returns adjusted flushing release peak end date.

Return Type: DATETIME

Arguments:

SLOT slot

Body

Referenced Functions

AdjustedEndDate
FlushingPeakFlow
FlushingCenterDate
OffsetDate
GetDates

4.23.3 AdjustmentStartDate

Return start date appropriate for adjustments.

Return Type: DATETIME

Arguments: None

Body

Referenced Functions

AdjustedStartDate

4.23.4 AdjustmentSlot

Determines slot to adjust.

Return Type: SLOT

Arguments: None

Body

Referenced Functions

AdjustedStartDate

4.23.5 AverageReleaseVolume

Computes average release volume given release type.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

FlushingEndDate
FlushingStartDate
FlowToVolume

4.23.6 BaseflowBypassAdjustment

Adjusts baseflow bypasses for case when we missed the appropriate baseflow method's seven day average.
Because this case is rarely encountered, we chose to do a brute force adjustment that takes care of
negative outflows and meets baseflow requriements. It is brute force because when we have a baseflow shortfall,
we are providing adjusted bypass to all four gages. This case appears to occur when the gage combination
changes. Applying the adjustment to all 4 gages should keep the gage combination from changing again.

Return Type: LIST

Arguments: None

Body

Referenced Functions

MakeForLoopList

4.23.7 BaseflowBypassAdjustmentNew

Return Type: LIST

Arguments: None

Body

Referenced Functions

MakeForLoopList

4.23.8 ComputeAdjustedRelease

Computes release adjusted for excess water as a function of conditions.

Return Type: LIST

Arguments:

NUMERIC excessDays
DATETIME flushingStartDate
NUMERIC releaseType
SLOT slot
LIST modelDates

Body

Referenced Functions

AdditionalNoseWater
PreFlushingReleaseNoseWater
ComputeNoseAdjustedRelease
OffsetDate
GetSlotVals

4.23.9 ComputeBypassFlow

Computes bypass flow given accumulated volume for timesteps of interest and target flow.

Return Type: NUMERIC

Arguments:

NUMERIC targetFlow
NUMERIC accumulatedVolume
NUMERIC numberTimesteps
NUMERIC timestep

Body

Referenced Functions

4.23.10 ComputeBackLoadedExtendedRelease

Computes release adjusted for extension of peak back loaded to hydrograph.

Return Type: LIST

Arguments:

NUMERIC excessDays
DATETIME beginDate
NUMERIC releaseType
SLOT slot
LIST modelDates

Body

Referenced Functions

FlushingPeakFlow
OffsetDate
GetSlotVals

4.23.11 ComputeCenteredExtendedRelease

Computes release adjusted for extension of peak centered around peak.

Return Type: LIST

Arguments:

NUMERIC excessDays
DATETIME flushingStartDate
NUMERIC releaseType
SLOT slot
LIST modelDates

Body

Referenced Functions

FlushingPeakFlow
FlushingCenterDate
OffsetDate
GetSlotVals

4.23.12 ComputeFrontLoadedExtendedRelease

Computes release adjusted for extension of peak front loaded to hydrograph.

Return Type: LIST

Arguments:

NUMERIC excessDays
DATETIME flushingStartDate
NUMERIC releaseType
SLOT slot
LIST modelDates

Body

Referenced Functions

FlushingPeakFlow
FlushingCenterDate
OffsetDate
GetSlotVals

4.23.13 ComputeModifiedRelease

Computes release modified for release extensions or curtailments.

Return Type: LIST

Arguments:

NUMERIC releaseType
LIST modelDates

Body

Referenced Functions

AdjustedEndDate
FlushingPeakFlow
OffsetDate
GetJulianDate

4.23.14 ExpectedALPAdjustment

Computes expected benefit of ALP mitigation operations.

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

4.23.15 FloodControlFlag_old

Flags if flood control should be computed.

Return Type: BOOLEAN

Arguments: None

Body

Referenced Functions

PreviousElevation

4.23.16 FloodControlFlag

Flags if flood control should be computed.

Return Type: BOOLEAN

Arguments: None

Body

Referenced Functions

PreviousElevation
GetMaxReleaseGivenInflow

4.23.17 FlushingAdjustedOpRelease

Computes operation release adjusted for flushing release. Any water before the peak should be released as a spike.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType
NUMERIC shortTermRelease

Body

Referenced Functions

4.23.18 FlushingUprampVolume

Computes volume before start of peak.

Return Type: NUMERIC

Arguments:

NUMERIC releaseType

Body

Referenced Functions

MakeForLoopList
GetFlowDurationSlot

4.23.19 GetReleaseTypeGivenPath

Sets flushing flows release type as a function of path, spill, and available water.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

IncrementalFlushingVolume

4.23.20 GetReleaseTypeGivenPathV1

Sets flushing flows release type as a function of path, spill, and available water.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
Min
Max

4.23.21 GetReleaseTypeGivenPathV2

Sets flushing flows release type as a function of path, spill, and available water.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
Min
Max

4.23.22 GetReleaseTypeGivenPathV3

Sets flushing flows release type as a function of path, spill, and available water.

Return Type: NUMERIC

Arguments:

NUMERIC path

Body

Referenced Functions

MaximumReleaseType
IncrementalFlushingVolume
Min
Max

4.23.23 IncreaseNavajoDailyFlows

Return Type: LIST

Arguments:

LIST accExtraCapc
NUMERIC extraWater
NUMERIC maxRelease

Body

Referenced Functions

Max
GetDayOfMonth
FlowToVolume

4.23.24 ListHistoricReleaseTypes

Makes a list of historic release types.

Return Type: LIST

Arguments:

NUMERIC numberYears

Body

Referenced Functions

MakeForLoopList
OffsetDate

4.23.25 MakeIntegratedFlowList

Integrates unadjusted release with extended peak.

Return Type: LIST

Arguments:

NUMERIC excessDays
DATETIME flushingStartDate
NUMERIC releaseType
LIST modelDates

Body

Referenced Functions

FindFlowGivenDateFromLists
MakeUnadjustedFlowList
FlushingPeakFlow
FlushingCenterDate
OffsetDate
GetDates

4.23.26 MaximumForcedReleaseType

Computes maximum forced release type as a function of absolute maximum amount of water that we can release.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

SumPeriodicFlowToVolume
EstimatedEndOfPeriodNavajoContent
IncrementalFlushingVolume
Max
GetMonthAsString
StorageToElevation

4.23.27 MaximumFlushingRelease

Computes maximum flushing release given supply.

Return Type: NUMERIC

Arguments:

NUMERIC supply

Body

Referenced Functions

IncrementalFlushingVolume

4.23.28 MaximumTwoGageAdjustment

Adjusts baseflow bypasses using maximum two gage method.

Return Type: LIST

Arguments: None

Body

Referenced Functions

MakeForLoopList
OffsetDate

4.23.29 MaximumWaterAvailableToNIIP

Return Type: NUMERIC

Arguments:

NUMERIC release
NUMERIC meanArea

Body

Referenced Functions

EstimateEvaporation
PreviousStorage
Max
FlowToVolume
ElevationToStorage
VolumeToFlow

4.23.30 MinimumForcedReleaseVolumeIsAvailable

Determines if minimum volume need to make a release iis available.

Return Type: BOOLEAN

Arguments: None

Body

Referenced Functions

SumPeriodicFlowToVolume
EstimatedEndOfPeriodNavajoContent
IncrementalFlushingVolume
Max
GetMonthAsString
StorageToElevation

4.23.31 MinimumTwoGageAdjustment

Computes second pass bypasses using minimum two gage method.

Return Type: LIST

Arguments: None

Body

Referenced Functions

MakeForLoopList
OffsetDate

4.23.32 NavajoFloodControlReleaseNoForecastError

Computes flood control release by a short term look and long term COE look.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

PreviousStorage
SumFlowsToVolumeSkipNaN
MaxItem
SumFlowsToVolume
Max
GetMaxReleaseGivenInflow
OffsetDate
DateMin

4.23.33 NavajoFloodControlRelease

Computes flood control release by a short term look and long term COE look.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

PreviousStorage
SumFlowsToVolumeSkipNaN
MaxItem
Max
OffsetDate
DateMin

4.23.34 NavajoFlushingOperationRelease

Computes operation release while accounting for flushing volumes.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

PreviousElevation
SurplusVolumeBySlotNoErr
Max
OffsetDate
DateMin

4.23.35 NavajoNormalOperationRelease

Computes Navajo normal operations release

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

PreviousElevation
SurplusVolumeBySlotNoErr
Max
OffsetDate
DateMin

4.23.36 NoFishReleasePastNYears

Determines if any release has been made in specified nears.

Return Type: BOOLEAN

Arguments:

NUMERIC numberYears

Body

Referenced Functions

IncrementalFlushingVolume
GetHistoricReleaseVolumes
Sum

4.23.37 NoMaxReleasePastNYears

Determines if the maxmimum release has been made in specific years.

Return Type: BOOLEAN

Arguments:

NUMERIC numberYears

Body

Referenced Functions

MaxItem

4.23.38 OpReleaseFlag

Flags if an operation release should be computed.

Return Type: BOOLEAN

Arguments: None

Body

4.23.39 OptimumFlushingRelease

Computes optimum flushing release given supply.

Return Type: NUMERIC

Arguments:

NUMERIC supply

Body

Referenced Functions

IncrementalFlushingVolume
Min

4.23.40 RampingConstrainedFlow

Constrains requested flow for ramping criteria.

Return Type: NUMERIC

Arguments:

NUMERIC requestedFlow

Body

Referenced Functions

NavajoDescendingLimit
NavajoAscendingLimit
Min
Max

4.23.41 RampedRelease

Ramps release to logical increments.

Return Type: NUMERIC

Arguments:

NUMERIC requestedFlow

Body

Referenced Functions

Ceiling
TableLookupDefaultTol

4.23.42 ReleaseIsNeeded

Returns true if a release is needed.

Return Type: BOOLEAN

Arguments: None

Body

4.23.43 ReleaseIsRequired

Returns true is a release is required.

Return Type: BOOLEAN

Arguments: None

Body

4.23.44 ReleasePriority

Computes release priority given release type.

Return Type: NUMERIC

Arguments:

NUMERIC eventType

Body

4.23.45 RemainingFlushingVolume

Computes incremental flushing volume for remainder of season from adjusted hydrograph.

Return Type: NUMERIC

Arguments:

DATETIME datetime
NUMERIC releaseType

Body

Referenced Functions

AdjustedStartDate
SumPeriodicFlowToVolume
AdjustedEndDate
SumFlowsToVolumeSkipNaN
Max
DateMax

4.23.46 SetFlushingFlowsPath_bw

Sets path by 1996 BO Flow Recseration decision tree.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

IncrementalFlushingVolume

4.23.47 SetFlushingFlowsPath

Sets path by 1996 BO Flow Recseration decision tree.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

IncrementalFlushingVolume

4.23.48 SetFlushingFlowsPathV1

Sets path by 1996 BO Flow Recseration decision tree.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

IncrementalFlushingVolume

4.23.49 SetFlushingFlowsPathV2

Sets path by 1996 BO Flow Recseration decision tree.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

IncrementalFlushingVolume

4.23.50 SupplementalBypass

Computes supplemental bypass as a function of baseflow method and first pass flows.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

MaxItem
Max

4.23.51 TargetForcedReleaseType

Returns target release type as a function of event return periods.

Return Type: NUMERIC

Arguments: None

Body

4.23.52 ThreeGageAdjustment

Computes three gage adjusted bypasses.

Return Type: LIST

Arguments: None

Body

Referenced Functions

MakeForLoopList
OffsetDate

4.23.53 ThreeGageAdjustmentNEW

Computes three gage adjusted bypasses.

Return Type: LIST

Arguments: None

Body

Referenced Functions

MakeForLoopList
MaxItem
Max
OffsetDate

4.23.54 ThreeGageBypasses_orig

Computes bypass flows using the three gage criteria.

Return Type: LIST

Arguments: None

Body

Referenced Functions

Min
Max
GetNumbers

4.23.55 WaterSupplyFlag

Flags if water supply rules for flushing decisions should fire.

Return Type: BOOLEAN

Arguments: None

Body

4.23.56 ThreeGageBypasses_prev

Computes bypass flows using the three gage criteria.

Return Type: LIST

Arguments: None

Body

Referenced Functions

4.24 Archived Operation Functions

4.24.1 AfterPeakReleaseBySlotNoErr

Computes release after runoff season by attempting to get reservoir to a target December space
requirement (ReservoirData.targetSpace December). Computes forecasted inflow for remainder of
year for subbasins AboveReservoirHydrology, AboveReservoirDepletions and AboveReservoirExports

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot

Body

Referenced Functions

Max
DateMin
GetJulianDate
VolumeToFlow

4.24.2 AfterPeakReleaseBySlotWithErr

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot
SLOT errorSlot

Body

Referenced Functions

Max
DateMin
GetJulianDate
VolumeToFlow

4.24.3 AfterPeakReleaseBySubWithErr

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot

Body

Referenced Functions

Max
DateMin
GetJulianDate
VolumeToFlow

4.24.4 AfterPeakVolumeBySlotNoErr

Computes after peak volume for a reservoir by slot with no forecast error applied.
Uses table ReservoirData.targetSpace December value.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
ComputeAvailableSpace
Max
DateMin
ElevationToStorage

4.24.5 AfterPeakVolumeBySubWithErr

Computes volume to release after the runoff season by attempting to get reservoir to a target December space
requirement (ReservoirData.targetSpace December). Computes forecasted inflow for remainder of year for
subbasins AboveReservoirHydrology, AboveReservoirDepletions and AboveReservoirExports.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
ComputeAvailableSpace
Max
DateMin
ElevationToStorage

4.24.6 AfterPeakVolumeBySlotWithErr

Computes volume to release after the runoff season by attempting to get reservoir to a target December space requirement.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot
SLOT errorSlot

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
ComputeAvailableSpace
Max
DateMin
ElevationToStorage

4.24.7 AvailableStorageWaterBySlotNoErr

omputes available storage water.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

SurplusVolumeBySlotNoErr
TotalAvailableWaterBySlotNoErr
Max

4.24.8 AvailableStorageWaterBySlotWithErr

Computes available storage water.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

4.24.9 AvailableStorageWaterBySubWithErr

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

4.24.10 DailyMaximumStorage

Computes daily maximum storage as a function of daily maximum elevation.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME datetime

Body

Referenced Functions

ElevationToStorage

4.24.11 DailyMinimumElevation

Interpolates daily minimum elevation from monthly table ReservoirData.MinElevation.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME datetime

Body

4.24.12 DailyMinimumStorage

Computes daily minimum storage as a function of daily minimum elevation

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME datetime

Body

Referenced Functions

ElevationToStorage

4.24.13 DailyMinimumStorageRelease

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME datetime
NUMERIC prevStorage
NUMERIC inflow

Body

Referenced Functions

Max
SolveOutflow

4.24.14 DailyTargetStorageRelease

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME datetime
NUMERIC prevStorage
NUMERIC inflow

Body

Referenced Functions

DailyTargetStorage
Max
SolveOutflow

4.24.15 FloodControlReleaseBySlot

Computes flood control release with forecast by slot.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT slot

Body

Referenced Functions

PreviousStorage
Max
SolveStorage
SolveOutflow
VolumeToFlow

4.24.16 FloodControlStorageBySlot

Computes flood control storage limit with forecast from a slot.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT slot

Body

Referenced Functions

GetMonthAsString
TableInterpolation

4.24.17 MinAndMaxFlowCheckWithDemands

Guarantees that reservoir meets instream flow requirement (ReservoirData.MinRelease)
and downstream demands while not violating monthy maximum release (ReservoirData.MaxRelease).

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC outflow

Body

Referenced Functions

Min
Max
ListSubbasin

4.24.18 MaxMinElevationCheck

Checks for maximum and minimum elevation constraints expressed in table
ReservoirData.MinElevation and ReservoirData.MaxElevation.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC request

Body

Referenced Functions

PreviousStorage
Min
Max

4.24.19 MaxMinElevationFlows

Attempts to meet instream flow requirement (ReservoirData.MinRelease)
while not violating maximum release (ReservoirData.MaxRelease) while also attempting to meet min
and max elevation constraints (ReservoirDataMinElevation and ReservoirData.MaxElevation) are met.
Preference is given to release constraints.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC request

Body

4.24.20 MinAndMaxFlowCheck

Guarantees that reservoir meets instream flow requirement (ReservoirData.MinRelease)
while not violating monthy maximum release (ReservoirData.MaxRelease).

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC outflow

Body

Referenced Functions

4.24.21 MinimumAvailableStorage

Returns minimum available water as reservoir storage.

Return Type: NUMERIC

Arguments:

OBJECT reservoir

Body

Referenced Functions

ElevationToStorage

4.24.22 MinMaxElevationFlowsWithDemands

Guarantees that reservoir meets instream flow requirement (ReservoirData.MinRelease)
and downstream demands while not violating monthy maximum release (ReservoirData.MaxRelease)
and that min and max elevation constraints (ReservoirDataMinElevation and
ReservoirData.MaxElevation) are met.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC outflow

Body

Referenced Functions

PreviousStorage

4.24.23 MinMaxElevationFlowsWithoutDemands

Guarantees that reservoir meets monthly instream flow requirement (ReservoirData.MinRelease)
while not violating monthy maximum release (ReservoirData.MaxRelease) and that monthly min
and max elevation constraints (ReservoirDataMinElevation and ReservoirData.MaxElevation) are met.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC outflow

Body

Referenced Functions

PreviousStorage

4.24.24 MinMaxElevationFlows

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC request

Body

4.24.25 MaximumElevationCheck

Adjust release to respect maximum elevation.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC request

Body

Referenced Functions

PreviousStorage
Min

4.24.26 MinimumElevationCheck

Adjust release to respect minimum elevation.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
NUMERIC request

Body

Referenced Functions

PreviousStorage
Max

4.24.27 MonthlyFloodControlRelease

Computes release as a function of monthly flood control storage and channel capacity.
Channel capacity is respected until live capacity is encroached.

Return Type: NUMERIC

Arguments:

OBJECT reservoir

Body

Referenced Functions

PreviousStorage
Max
SolveStorage
SolveOutflow
VolumeToFlow

4.24.28 DailyMaximumStorageRelease

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME datetime
NUMERIC prevStorage
NUMERIC inflow

Body

Referenced Functions

Max
SolveOutflow
ElevationToStorage

4.24.29 MonthlyFloodControlStorage

Computes Corp of Engineers Flood Control allowable storage given flood season forecast using table FloodControlTables.

Return Type: NUMERIC

Arguments:

OBJECT reservoir

Body

Referenced Functions

GetMonthAsString
TableInterpolation

4.24.30 DailyFloodControlStorage

Computes maximum storage that we can be at today given a forecast thru endDate
and the maximum daily release (maxRelease).

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME endDate
NUMERIC maxRelease
NUMERIC forecastVolume

Body

Referenced Functions

SumFlowValueToVolume
Min
Max
ElevationToStorage

4.24.31 RunoffSeasonReleaseBySlotNoErr

Attempts to fill reservoir without spilling by a specified filling date
during runoff season. Runoff season is assumed to start in
January. This is the Fill and Not Spill rule.
The flow of a given time step is a fraction from a lookup table
times estimated surplus volume above filling volume.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME startDate
DATETIME fillDate
SLOT forecastSlot

Body

Referenced Functions

SurplusVolumeBySlotNoErr
GetMonthAsString
VolumeToFlow

4.24.32 RunoffSeasonReleaseBySlotWithErr

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME startDate
DATETIME fillDate
SLOT forecastSlot
SLOT errorSlot

Body

Referenced Functions

GetMonthAsString
VolumeToFlow

4.24.33 DailyFloodControlRelease

Computes flood control release for a daily time step as function of today's maximum storage
and today's flood control storage.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME endDate
NUMERIC maxRelease
NUMERIC forecastVolume

Body

Referenced Functions

Max
SolveStorage
SolveOutflow
ElevationToStorage

4.24.34 RunoffSeasonReleaseBySubWithErr

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot
DATETIME startDate
DATETIME fillDate

Body

Referenced Functions

GetMonthAsString
VolumeToFlow

4.24.35 SurplusVolumeBySlotWithErr

Computes surplus volume from inflows less depletions stored in specified slot.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
ComputeAvailableSpace
Max
ElevationToStorage

4.24.36 SurplusVolumeBySubWithErr

Estimates volume that will be surplus in reservoir accouunting for existing
storage and anticipated upstream inflows and depletions.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
ComputeAvailableSpace
Max
ElevationToStorage

4.24.37 TotalAvailableWaterBySlotWithErr

Computes total available water (surplus plus storage less reserve).

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
Max
ElevationToStorage

4.24.38 TotalAvailableWaterBySubWithErr

Computes total available water (surplus plus storage less reserve).

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

EstimateEvaporation
GetMeanArea
SumPeriodicFlowToVolume
PreviousStorage
DailyTargetStorage
Max
ElevationToStorage

4.24.39 DownstreamDemands

Return Type: NUMERIC

Arguments:

LIST listOfReachesAndConfluences

Body

Referenced Functions

NetSubBasinDiversionRequirement

4.24.40 GetSubBasinDiversionShortage

Return Type: NUMERIC

Arguments:

STRING subbasin

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.25 Archived Forecast Functions

4.25.1 AprilJulyNaturalInflow

Return Type: NUMERIC

Arguments:

OBJECT reservoir

Body

Referenced Functions

GetMonth

4.25.2 AprilJulyUnregulatedInflow

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot

Body

Referenced Functions

4.25.3 DailyForecastErrorPercent

Interpolates daily forecast error percents from monthly values. Note that the monthly values are actually for the first day of the month.
Therefore the first day of each month in the daily return should correspond to the monthly value.

Return Type: NUMERIC

Arguments:

SLOT monthlyForecastSlot
DATETIME datetime

Body

Referenced Functions

EndOfMonthDate
GetDaysInMonth
OffsetDate
DateMin
GetDayOfMonth
GetMonth

4.25.4 HydrologicInflowVolumeBySlotWithErr

Computes hydrologic inflow forecast volume for a reservoir by slot with forecast error applied.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT forecastSlot
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

4.25.5 HydrologicInflowVolumeBySubNoErr

Computes hydrologic inflow forecast volume for a reservoir by subbasin with no forecast error applied.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

4.25.6 HydrologicInflowVolumeBySubWithErr

Computes hydrologic inflow forecast volume for a reservoir by subbasin with forecast error applied.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

4.25.7 HydrologicVolumeWithError

Return Type: NUMERIC

Arguments:

SLOT flowSlot
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

SumFlowsToVolumeSkipNaN

4.25.8 PreviousForecastError

Returns previous forecast error given reservoir name.

Return Type: NUMERIC

Arguments:

OBJECT reservoir

Body

Referenced Functions

GetMonth

4.25.9 SumDeplsExports

Sums anticipated depletions and exports for a resevoir.

Return Type: NUMERIC

Arguments:

OBJECT object
STRING direction
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

SumObjectsAggregatedOverTime

4.25.10 SumUpstreamInflow

Sums all user provided inflows and local inflows for a subbasin upstream of
a reservoir in a given period. Subbasin name is specified as 'AboveReservoirReservoirs'.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

SumObjectsAggregatedOverTime

4.25.11 UnregulatedInflowVolumeBySlotNoErr

Computes unregulated inflow volume without error from specified slot.

Return Type: NUMERIC

Arguments:

SLOT forecastSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

SumSlotSkipNaN

4.25.12 UnregulatedInflowVolumeBySlotWithErr

Computes unregulated inflow from hydrology slot and forecast error slot.

Return Type: NUMERIC

Arguments:

SLOT forecastSlot
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

GetYear
GetMonth

4.25.13 UnregulatedInflowVolumeBySubNoErr

Computes unregulated inflow forecast volume for a reservoir by subbasin without forecast error applied.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
DATETIME startDate
DATETIME endDate

Body

4.25.14 UnregulatedInflowVolumeBySubWithErr

Computes unregulated inflow forecast volume for a reservoir by subbasin with forecast error applied.

Return Type: NUMERIC

Arguments:

OBJECT reservoir
SLOT errorSlot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

GetYear
GetMonth

4.26 Archived ALP Functions

4.26.1 ALPSupplementFishRelease

Computes supplemental release from Ridges Basin to meet minimum flow restrictions on San Juan.

Return Type: NUMERIC

Arguments:

DATETIME datetime
NUMERIC sjConstrainingFlow

Body

Referenced Functions

Max
GetMonthAsString

4.26.2 FlushingPeriodAvailableForDiversion

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

4.26.3 FlushingPeriodFishIntakeBypass

Return Type: NUMERIC

Arguments:

DATETIME datetime
NUMERIC sjConstrainingFlow

Body

Referenced Functions

DateIsBetween
FlushingEndDate
FlushingStartDate
MaxItem
Max
GetMonthAsString

4.26.4 FlowRangesAvailableForDiversion

Computes bypass for fish purposes. Pumping Limit = Constraining Flow - Bypass.
Bypass = Contstraining Flow - Pumping Limit.

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

4.26.5 FlowRangesFishIntakeBypass

Computes bypass for fish purposes. Pumping Limit = Constraining Flow - Bypass.
Bypass = Contstraining Flow - Pumping Limit.

Return Type: NUMERIC

Arguments:

DATETIME datetime
NUMERIC SJFarmington
NUMERIC sjConstrainingFlow

Body

Referenced Functions

Max
GetMonthAsString
GetMonth

4.26.6 JuneOnlyAvailableForDiversion

Only limits pumping in June.

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

4.26.7 JuneOnlyFishIntakeBypass

Only restricts pumping in June.

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

GetMonth

4.26.8 OneWindowAvailableForDiversion

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

4.26.9 OneWindowFishIntakeBypass

Return Type: NUMERIC

Arguments:

DATETIME datetime
NUMERIC sjConstrainingFlow

Body

Referenced Functions

Max
GetMonthAsString
GetMonth

4.26.10 SanJuanConstrainingFlow

Returns minimum estimated flow of San Juan at Farmington, Shiprock, Stateline, and Bluff.

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

MinItem

4.26.11 NetEffectALPAnimasAtFarmington

Computes net affect of ALP on Animas At Farmington.

Return Type: NUMERIC

Arguments: None

Body

4.26.12 RidgesBasinDailyInflowLimit

Return Type: NUMERIC

Arguments:

BOOLEAN mitigationPass

Body

Referenced Functions

PreviousStorage
Min
Max
SolveInflow

4.26.13 AnimasDownstreamUsersDivShortage

Computes diversion shortages of historic water users downstream of ALP.

Return Type: NUMERIC

Arguments: None

Body

4.26.14 NormalIntakeBypass_PREV

Computes normal bypass of pumping plant.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

Min
Max
ListSubbasin
GetMonthAsString

4.26.15 NormalIntakeBypass

Computes normal bypass of pumping plant.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

Min
Max
ListSubbasin
GetMonthAsString
NetSubBasinDiversionRequirement
ListDownstreamObjects

4.26.16 ALPDiversionByPass

Return Type: NUMERIC

Arguments: None

Body

4.26.17 DurangoDailyDirectFlowSupply

Computes Durango daily direct flow supply.

Return Type: NUMERIC

Arguments: None

Body

Referenced Functions

4.26.18 RidgesBasinDailyDiversionLimit

Set daily diversion limit in terms of pump limitations and available for diversion.

Return Type: NUMERIC

Arguments:

NUMERIC availableToDivert

Body

Referenced Functions

Max
GetMonthAsString

4.26.19 ReturnsAvailableForFishBypass

Return Type: NUMERIC

Arguments: None

Body

4.26.20 ALPWaterUserReturnFlow

Estimates return flows from ALP water users.

Return Type: NUMERIC

Arguments:

OBJECT wateruser
DATETIME datetime

Body

4.26.21 DurangoAreaReturnFlows

Estimates returns that must be bypasses by water users upstream of reservoir release.

Return Type: NUMERIC

Arguments: None

Body

4.26.22 ReturnsAvailableForNewMexico

Return Type: NUMERIC

Arguments: None

Body

4.26.23 RidgesBasinCapacityChecks

Does a crude check on inactive capacity and check of outlet works capacity.

Return Type: NUMERIC

Arguments:

NUMERIC release
NUMERIC inflow

Body

Referenced Functions

Min
GetMaxReleaseGivenInflow

4.27 Archived Functions

4.27.1 InsertValueDateSetIntoList

Inserts a value and date set into a list of flows and dates.

Return Type: LIST

Arguments:

NUMERIC flow
DATETIME date

Body

4.27.2 InsertSlotValueSetIntoList

Inserts specified slot and value into a list.

Return Type: LIST

Arguments:

SLOT slot
NUMERIC value

Body

4.27.3 MakeListFromValueAndDates

Makes a list of daily values for a given value.

Return Type: LIST

Arguments:

NUMERIC dailyValue
LIST datesToUse

Body

4.27.4 MakeIncrementalListGivenInitIncrMax

Creates a list given an initial value, an inrement, and a maximum.

Return Type: LIST

Arguments:

NUMERIC initial
NUMERIC increment
NUMERIC maximum

Body

4.27.5 MakeIncrementalListGivenInitIncrPoints

Creates a list of values given an inital value, an incremental value, and number of points.

Return Type: LIST

Arguments:

NUMERIC initial
NUMERIC increment
NUMERIC numberPoints

Body

Referenced Functions

MakeForLoopList

4.27.6 MakeListOfValuesAndDates

Returns a list of values and dates.

Return Type: LIST

Arguments:

LIST flows
LIST dates
LIST listOfDays

Body

4.27.7 MakeListOfSlotsAndValues

Makes a list of lists of slots and values

Return Type: LIST

Arguments:

LIST slotsList
LIST valuesList
LIST numberInList

Body

4.27.8 ProportionDailyFlowList

Proportions a list of daily flow values by user provided ratio.

Return Type: LIST

Arguments:

NUMERIC ratio
SLOT slot

Body

Referenced Functions

GetDates

4.27.9 SubsetNumericList

Subsets a list for specified first and last indices.

Return Type: LIST

Arguments:

LIST listToSubset
NUMERIC firstIndex
NUMERIC lastIndex

Body

Referenced Functions

MakeForLoopList

4.27.10 SubtractNumericLists

Returns a numeric list after subtracting 2 lists.

Return Type: LIST

Arguments:

LIST firstList
LIST secondList

Body

Referenced Functions

MakeForLoopList

4.27.11 GetUnitlessDaysInMonth

Returns days in month as NONE units.

Return Type: NUMERIC

Arguments:

DATETIME datetime

Body

Referenced Functions

GetDaysInMonth

4.27.12 GetNumberOfDays

Returns number of days in specfied period.

Return Type: NUMERIC

Arguments:

NUMERIC timeStep
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

GetJulianDate

4.27.13 PeriodAverage

Computes Period Average

Return Type: NUMERIC

Arguments:

SLOT slot
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

Sum
GetSlotVals

4.27.14 LastSixDaysAverage

Computes average of last six days.

Return Type: NUMERIC

Arguments:

SLOT slot

Body

Referenced Functions

OffsetDate

4.27.15 BeginOfMonthDate

Returns beginning of month date given a date.

Return Type: DATETIME

Arguments:

DATETIME dateTime

Body

Referenced Functions

PreviousDate

4.27.16 AverageDailyFlowForVolume

Computes average daily flow given a volume and period.

Return Type: NUMERIC

Arguments:

NUMERIC volume
DATETIME startDate
DATETIME endDate

Body

Referenced Functions

GetJulianDate
VolumeToFlow

4.27.17 EndOfPreviousMonthDate

Returns date corresponding to last day of previous month.

Return Type: DATETIME

Arguments:

DATETIME dateTime

Body

Referenced Functions

OffsetDate
GetDayOfMonth

4.28 Archived Depletion Functions

4.28.1 ApparentDepletionMultiReturns

Computes apparent depletion for a mutiple return flow water user. Water user has to already have fired.

Return Type: NUMERIC

Arguments:

OBJECT waterUser
DATETIME dateTime

Body

4.28.2 ApparentDepletionSingleReturn

Computes apparent depletion for a single return flow water user. Water user has to already have fired.

Return Type: NUMERIC

Arguments:

OBJECT waterUser
DATETIME dateTime

Body

4.28.3 DiversionRequestAtMaxEfficiency

Computes diversion request at maximum efficiency

Return Type: NUMERIC

Arguments:

OBJECT waterUser
DATETIME dateTime

Body

Referenced Functions

4.28.4 GetEfficiencyGivenDiversion

Computes efficiency as a function of diversion.

Return Type: NUMERIC

Arguments:

OBJECT waterUser
NUMERIC diversion
DATETIME dateTime

Body

Referenced Functions

4.28.5 GetRegionDiversionShortage

Computes Regional Diversion Shortage

Return Type: NUMERIC

Arguments:

STRING region

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.6 GetRegionDepletionShortage

Computes Regional Shortage

Return Type: NUMERIC

Arguments:

STRING region

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.7 GetSubBasinApparentDepletion

Computes apparent depletion for specified subbasin for diversions not
involved whole or partially in an export.

Return Type: NUMERIC

Arguments:

STRING subbasinPrefix

Body

4.28.8 GetSubBasinApparentDepletionOneReturn

Takes the water users of a subbasin with only one return flow and finds the sum of the apparent depletions.

Return Type: NUMERIC

Arguments:

STRING subbasin

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.9 GetSubBasinApparentDepletionMultReturns

Takes the water users in a subbasin with multiple return flows and finds the sums of the apparent depletions.

Return Type: NUMERIC

Arguments:

STRING subbasin

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.10 GetSubBasinDepletionShortage

Return Type: NUMERIC

Arguments:

STRING subbasin

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.11 GetSubBasinExports

Computes sums of a diversion slot for a subbasin. User creates subbasin as an export.

Return Type: NUMERIC

Arguments:

STRING subbasin

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.12 RegionAvailable

Returns sum of total available water for a region.

Return Type: NUMERIC

Arguments:

STRING region

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.13 RegionDepletionRequest

Sums region (subbasin DownstreamRegion) depletion request.

Return Type: NUMERIC

Arguments:

STRING region

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.14 RegionDiversionRequest

Sums region (subbasin DownstreamRegion) diversion request.

Return Type: NUMERIC

Arguments:

STRING region

Body

Referenced Functions

ListSubbasin
FilterByObjType

4.28.15 RegionHadDepletionShortage

Calls GetRegionDepletionShortage and returns TRUE if depletion shortage is greater
than 0.0.

Return Type: BOOLEAN

Arguments:

STRING region

Body

4.28.16 RegionHadDiversionShortage

Calls GetRegionDiversionShortage and returns TRUE if diversion shortage is greater
than 0.0.

Return Type: BOOLEAN

Arguments:

STRING region

Body

4.28.17 SubBasinHadDepletionShortage

Return Type: BOOLEAN

Arguments:

STRING subbasin

Body

4.28.18 SubBasinHadDiversionShortage

Return Type: BOOLEAN

Arguments:

STRING subbasin

Body

4.28.19 SumRegionRequest

Sums diversion request of a region.

Return Type: NUMERIC

Arguments:

STRING region

Body

Referenced Functions

ListSubbasin
NetNonShortDiversionRequirement
FilterByObjType

SJBHM Appendix J - Current State of SJRIP RiverWare Model

1 General Model Information

2 List of Current Model Objects

3 Initialization Ruleset

3.1 Baseline Initialization Rules

3.1.1 Initialize Old Flow Recs Slots

3.1.2 Initialize Old Flow Recs Perturbations

3.1.3 Initial Pool Elevations and GW Storages

3.1.4 Initialize SJC Monthly Model and Net Shortage Adjustment

3.1.5 Setup SJC Reoperation

3.1.6 Initialize Baseflow Slots

3.1.7 Initialize New Flow Recs Calcs

3.2 Initialize Water Users

3.2.1 Set NIIP Daily Demands

3.2.2 Initialize and Target NIIP Demands

3.2.3 Set NIIP GW Return Flow Fractions and NIIP Available Water

3.2.4 Set Calibrated NIIP GW Outflow Tables for Run Configuration

3.2.5 Initialize Navajo Gallup Water Supply Project Demands

3.2.6 Set Unspecified Depletion and Diversion Requests

3.2.7 Initialize Non Irrigation Water Users

3.2.8 Set StateMod Inputs - Water Users

3.2.9 Initialize Other ALP/RBR Demands - R Flags

3.2.10 Initialize ALP/RBR Demands - Z Flags

3.2.11 ADDADDADD --------------- VERIFY ET RATES FOR NON CLIMATE CHANGE

3.3 Initialize Flows - Z Flags

3.3.1 Set StateMod Inputs - Flows

3.3.2 Set Local Inflow Inputs

3.3.3 Calculate Disaggregation Fractions for StateMod Disaggregation

3.3.4 SHOULD TEST IMPACT ON FLOW REC PERFORMANCE ----- Smooth Historic Flows For Disaggregation Ratios

3.3.5 Calculate and Apply Shifts for Monthly to Daily Flow Disagg Factors

3.3.6 Initialize Pre-Run Return Flows to 0 for Routing

3.4 Initialize ETAC and Interpolation/Disaggregation Method

3.4.1 Setup ETAC Water Users with Disaggregation Results

3.4.2 Initialize Daily ETAC CIR - New Disagg Set Final - RECOMMENDED

3.4.3 Initialize Daily ETAC CIR - Monthly Avg Method

3.4.4 Save Example 5th Iteration

3.4.5 5 Initialize Daily ETAC CIR New Disagg Step 2 - Adjust for Monthly Volumes

3.4.6 5 Initialize Daily ETAC CIR New Disagg Step 1.5 - Calc Interim Avgs

3.4.7 5 Initialize Daily ETAC CIR New Disagg Step 1 - Running Avg

3.4.8 Save Example 4th Iteration

3.4.9 4 Initialize Daily ETAC CIR New Disagg Step 2 - Adjust for Monthly Volumes

3.4.10 4 Initialize Daily ETAC CIR New Disagg Step 1.5 - Calc Interim Avgs

3.4.11 4 Initialize Daily ETAC CIR New Disagg Step 1 - Running Avg

3.4.12 Save Example 3rd Iteration

3.4.13 3 Initialize Daily ETAC CIR New Disagg Step 2 - Adjust for Monthly Volumes

3.4.14 3 Initialize Daily ETAC CIR New Disagg Step 1.5 - Calc Interim Avgs

3.4.15 3 Initialize Daily ETAC CIR New Disagg Step 1 - Running Avg

3.4.16 Save Example 2nd Iteration

3.4.17 2 Initialize Daily ETAC CIR New Disagg Step 2 - Adjust for Monthly Volumes

3.4.18 2 Initialize Daily ETAC CIR New Disagg Step 1.5 - Calc Interim Avgs

3.4.19 2 Initialize Daily ETAC CIR New Disagg Step 1 - Running Avg

3.4.20 Save Example 1st Iteration

3.4.21 Initialize Daily ETAC CIR New Disagg Step 2 - Adjust for Monthly Volumes

3.4.22 Initialize Daily ETAC CIR New Disagg Step 1.5 - Calc Interim Avgs

3.4.23 Initialize Daily ETAC CIR New Disagg Step 1 - Running Avg

3.4.24 Initialize Daily ETAC CIR New Disagg Step 0 - Start at Monthly Avgs

3.5 Run Setup

3.5.1 Make Climate Change CIR/ET Adjustments If Applicable (Or Set Back To Baseline)

3.5.2 Make Climate Change Reservoir Evaporation Rate Adjustments If Applicable (Or Set Back To Baseline)

3.5.3 Calculate Maintenance Release Volumes

3.5.4 Set ETAC Water User Acres and Efficiencies - Must be R Flags

3.5.5 NOT SET UP THIS WAY ANYMORE Set Run Demands Type and Restoration Release Type - Baseline vs. Current Conditions

3.5.6 Set Run Finished Completely Flag to 0

3.6 Initialization Functions

3.6.1 EndOfMonthDate

3.6.2 Return1

3.6.3 CurrentScenarioStateModInputsDataObject

4 Main Ruleset

4.1 End Of Run Rules

4.1.1 Mark Run Finished Completely

4.1.2 Check NIIP GW Calibration

4.1.3 Calculate Average Annual Diversions and Depletions

4.1.4 RC4 - Sum Annual Diversions and Depletions

4.1.5 RC3 - Sum Annual Diversion and Depletion Requests

4.1.6 Verify Supplemental Water was Removed

4.2 End of Timestep Rules

4.2.1 Save Final Daily Flood Control Reach Flows by Run Cycle

4.2.2 Save Final Daily Mainstem Diversion and Return Flow by Run Cycle

4.3 Navajo Ops - Cycle 4

4.3.1 NOT YET FINISHED OR IMPLEMENTED -------- RC4 - Coming out of Shortage Years Only - Apply Supplemental Water Correction